home *** CD-ROM | disk | FTP | other *** search
/ IRIX 6.4 Applications 1997 August / SGI IRIX 6.4 Applications 1997 August.iso / dist / insight.idb / usr / share / catman / u_man / cat1 / dtl2sgft.z / dtl2sgft
Encoding:
Text File  |  1997-07-30  |  6.7 KB  |  133 lines
  1.  
  2.  
  3.  
  4. DDDDTTTTLLLL2222SSSSGGGGFFFFTTTT((((1111))))                                                        DDDDTTTTLLLL2222SSSSGGGGFFFFTTTT((((1111))))
  5.  
  6.  
  7.  
  8. NNNNAAAAMMMMEEEE
  9.      dtl2sgft - Online Documentation Administration Utility for InfoSearch
  10.  
  11. SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  12.      /usr/sbin/dtl2sgft [ -b bbbbooooooookkkk____nnnnaaaammmmeeee ] [ -s bbbbooooooookkkksssshhhheeeellllffff____ppppaaaatttthhhh ]
  13.                         [ -q ggggrrrraaaannnnuuuullllaaaarrrriiiittttyyyy____qqqqrrrryyyy ] [ -t ttttiiiittttlllleeee____ttttaaaagggg ]
  14.                         [ -h hhhheeeellllpppp____qqqqrrrryyyy ] [ -d ddddaaaattttaaaa____ddddiiiirrrr ] [ -w ]
  15.                         [ -a aaaauuuutttthhhhoooorrrriiiizzzzaaaattttiiiioooonnnn____ssssttttrrrriiiinnnngggg ] [ -u uuuusssseeee____sssshhhheeeellllffffnnnnaaaammmmeeee ]
  16.  
  17.  
  18. DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  19.      _d_t_l_2_s_g_f_t is a utility program used to assist in maintaining a full-text
  20.      searchable index of online books available to the _i_n_f_o_s_e_a_r_c_h(1)
  21.      application.
  22.  
  23.      For a specified _i_n_s_i_g_h_t(1) online book, _d_t_l_2_s_g_f_t builds a full-text
  24.      indexable word file which is an extraction of the content of the book.
  25.      This word file is used in conjunction with the _b_o_o_k_s_A_d_m_i_n(1) utility to
  26.      aid in constructing and maintaining a full-text index. Along with the
  27.      word file, a HTML-based version of the book's table of contents is also
  28.      produced.
  29.  
  30.      An administrator should never have to run this process by hand.  Normally
  31.      it will be launched by the _b_o_o_k_s_A_d_m_i_n(1) utility.  If it is run manually,
  32.      the only options required when processing _i_n_s_i_g_h_t(1) online books are -b
  33.      and -s, as described below.
  34.  
  35. OOOOPPPPTTTTIIIIOOOONNNNSSSS
  36.      Command line options are described below.
  37.  
  38.      -b   The -b bbbbooooooookkkk____nnnnaaaammmmeeee required option tells _d_t_l_2_s_g_f_t to examine the
  39.           specified book.  The bbbbooooooookkkk____nnnnaaaammmmeeee is the abbreviated short title for
  40.           the book.  See _i_n_s_i_g_h_t(1) for more details on bookshelves.
  41.  
  42.      -s   The -s bbbbooooooookkkksssshhhheeeellllffff____ppppaaaatttthhhh required option tells _d_t_l_2_s_g_f_t which specific
  43.           bookshelf the bbbbooooooookkkk____nnnnaaaammmmeeee is on.  See _i_n_s_i_g_h_t(1) for more details on
  44.           bookshelves.
  45.  
  46.           For example,
  47.  
  48.           ddddttttllll2222ssssggggfffftttt ----bbbb IIIIRRRRIIIISSSSEEEEsssssssseeeennnnttttiiiiaaaallllssss ----ssss
  49.           ////uuuussssrrrr////sssshhhhaaaarrrreeee////IIIInnnnssssiiiigggghhhhtttt////lllliiiibbbbrrrraaaarrrryyyy////SSSSGGGGIIII____bbbbooooooookkkksssshhhheeeellllvvvveeeessss////SSSSGGGGIIII____EEEEnnnnddddUUUUsssseeeerrrr
  50.  
  51.      -q   The -q ggggrrrraaaannnnuuuullllaaaarrrriiiittttyyyy____qqqqrrrryyyy option indicates the level of granularity in
  52.           which to break up the book into. This is specific to the SGML
  53.           instance (tag set) used within the book. For example, the default
  54.           is: "<INTRODUCTION> OR <CHAPTER> OR <APPENDIX>".
  55.  
  56.      -t   The -t ttttiiiittttlllleeee____ttttaaaagggg option indicates the SGML instance tag used to
  57.           designate titles within the content. The default is "TITLE".
  58.  
  59.  
  60.  
  61.  
  62.  
  63.                                                                         PPPPaaaaggggeeee 1111
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. DDDDTTTTLLLL2222SSSSGGGGFFFFTTTT((((1111))))                                                        DDDDTTTTLLLL2222SSSSGGGGFFFFTTTT((((1111))))
  71.  
  72.  
  73.  
  74.      -h   The -h hhhheeeellllpppp____qqqqrrrryyyy is used by those books which also contain help
  75.           information. Separate word and HTML files will be produced for help
  76.           content. The default is "<HELPID>". _d_t_l_2_s_g_f_t uses this tag to search
  77.           within the book for the existence of any "help cards" and their
  78.           content will be extracted accordingly.
  79.  
  80.      -d   The -d ddddaaaattttaaaa____ddddiiiirrrr points to the default data directory. It should not
  81.           need to be set. The default is "/usr/lib/Insight/data".
  82.  
  83.      -a   The -a aaaauuuutttthhhhoooorrrriiiizzzzaaaattttiiiioooonnnn____ssssttttrrrriiiinnnngggg option instructs _d_t_l_2_s_g_f_t to use the
  84.           designated string as an authorization key for processing books that
  85.           have been licensed. At this time, this option will not be needed for
  86.           the online books from _S_i_l_i_c_o_n _G_r_a_p_h_i_c_s.
  87.  
  88.      -u   The -u uuuusssseeee____sssshhhheeeellllffffnnnnaaaammmmeeee option instructs _d_t_l_2_s_g_f_t to use this string as
  89.           a bookshelf designation, both in the resultant word and HTML
  90.           file(s).  The default is to use the end of the path string specified
  91.           for bbbbooooooookkkksssshhhheeeellllffff____ppppaaaatttthhhh.
  92.  
  93.           If /usr/share/Insight/library/SGI_bookshelves/SGI_EndUser is
  94.           specified for bbbbooooooookkkksssshhhheeeellllffff____ppppaaaatttthhhh, the truncated string used to in the
  95.           word and HTML file(s) is "SGI_EndUser". The -u uuuusssseeee____sssshhhheeeellllffffnnnnaaaammmmeeee option
  96.           overrides the aforementioned default.
  97.  
  98.      -w   The -w option instructs _d_t_l_2_s_g_f_t to only create HTML-based table of
  99.           contents file(s) for _web access.
  100.  
  101. SSSSEEEEEEEE AAAALLLLSSSSOOOO
  102.      _i_n_f_o_s_e_a_r_c_h(_1), _s_g_s_e_a_r_c_h(_1)
  103.  
  104.  
  105.  
  106.  
  107.  
  108.  
  109.  
  110.  
  111.  
  112.  
  113.  
  114.  
  115.  
  116.  
  117.  
  118.  
  119.  
  120.  
  121.  
  122.  
  123.  
  124.  
  125.  
  126.                                                                         PPPPaaaaggggeeee 2222
  127.  
  128.  
  129.  
  130.  
  131.  
  132.  
  133.